Skip to content

docs(examples): add TFIM ground-state and SU(3) Heisenberg examples - #502

Draft
lkdvos wants to merge 1 commit into
mainfrom
docs/new-examples
Draft

lkdvos wants to merge 1 commit into
mainfrom
docs/new-examples

Conversation

@lkdvos

@lkdvos lkdvos commented Aug 3, 2026 •

Copy link
Copy Markdown
Member

Adds two examples to the gallery, on top of the current documentation structure (no longer stacked on #449).

  • groundstates/tfim-groundstate locates the phase transition of the transverse-field Ising chain three ways: the order parameter on a finite chain and in the thermodynamic limit, the entanglement entropy, and the correlation length. An introductory entry for the gallery, without symmetries.
  • excitations/su3-heisenberg covers the SU(3) Heisenberg chain of [3 0 0] irreps from [devos2022] using SUNRepresentations, the only example with a non-abelian symmetry beyond SU(2).

The SU(3) example is built around the fact that quasiparticle excitation energies are not variational. At the starting bond dimension (D = 165) the gap at k = 2π/3 comes out negative (−0.042), because it is measured relative to an approximate ground state. Growing the bond dimension with changebonds(ψ, H, OptimalExpand(; trunc = truncrank(150))) and reconverging with VUMPS brings it to +0.0128 at D = 1195. It is still rising there and remains below the +0.0263 reported in the paper, which the page states explicitly.

Both pages are the output of examples/make.jl against current main. Adding SUNRepresentations to examples/Project.toml changes the cache checksums of every example, so Cache.toml is refreshed for the others without rerunning them, since their output does not depend on it.

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

After the build completes, the updated documentation will be available here

@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

The gallery had no beginner entry point: every example already assumed familiarity with the
API. `groundstates/0.tfim-groundstate` is a complete ground-state study of the
transverse-field Ising model — the same model the tutorials use — from a product state
through DMRG, magnetization and correlation functions.

`excitations/1.su3-heisenberg` covers the SU(3) Heisenberg chain using `SUNRepresentations`,
which is the only example exercising a non-abelian symmetry beyond SU(2). Its dispersion
reproduces the soft-mode location of the reference but not the reported gap value; the page
says so explicitly rather than quietly presenting the number as agreement.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@lkdvos
lkdvos force-pushed the docs/new-examples branch from 25dba7b to 8d3395a Compare November 7, 2026 18:34
@lkdvos
lkdvos changed the base branch from docs/content-wave1 to main November 7, 2026 18:35
@lkdvos
lkdvos marked this pull request as ready for review November 7, 2026 18:41
@lkdvos lkdvos closed this Nov 7, 2026
@lkdvos lkdvos reopened this Nov 7, 2026
@lkdvos
lkdvos marked this pull request as draft November 7, 2026 19:30

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant